Document how to write python-lsp-server plugin + add pylsp-rope to Readme #93
Conversation
I agree with this and thanks a lot for your help and interest in our project. I'll create a repo for that cookiecutter and add you as admin so you can move it to our organization.
Nice! Good luck with that project. Perhaps we could use it in Spyder in the future. |
|
Thanks for the invite @ccordoba12, I've migrated the cookiecutter/doc project over to python-lsp and updated the pull request accordingly.
Once the project matures a bit. That would be lovely! |
ccordoba12
changed the title
Currently, writing a plugin for python-lsp-server is rather difficult, there is very little documentation on how to do this other than just a short pointer to "see [existing plugins] for examples on how to write plugins".
There's quite a number of non-obvious knowledge that one has to know, which is quite an impediment for people wanting to write plugins. I wanted to change that, so I've written a cookiecutter template that aims to make it much easier to start a pylsp plugin project and also aims to document how to write plugins in more depth.
Ideally, I think python-lsp-server documentation should be owned by python-lsp's organisation rather than in my own repository, so I'd request if python-lsp-server core maintainers are interested in this project, to help adopt the project into the python-lsp Github Organisation, so it can be maintained by the community rather than as an external project on my user's namespace.
The primary test case for this template is pylsp-rope, which is the first pylsp plugin written to use the template and the main driver for me wanting to write a python-lsp-server plugin. Also, this just happens to be the first public announcement of pylsp-rope, so I'm also quite excited to announce that now you can use Rope from an LSP, beyond the basic renaming and completion that exists in the current built-in Rope support.